| API Documentation |  |

- MAIN PAGE
- NAMESPACES
- CLASSES

DofComplexEffect.h
1 // DofComplexEffect.h
3 //
5
6 namespace nkAstraeus
7 {
21 class DofComplexEffect final : public ComplexEffect
22 {
23 public :
24
31 DofComplexEffect (System* system) noexcept ;
35 virtual ~DofComplexEffect () ;
36
37 // Getters
41 nkGraphics::Texture* getSourceTexture () const ;
45 nkGraphics::Texture* getSourceDepth () const ;
52 nkGraphics::Texture* getOutputTexture () const ;
56 nkGraphics::Camera* getCamera () const ;
60 float getNearPlaneDistance () const ;
64 float getFocalPlaneDistance () const ;
68 float getFocalPlaneThickness () const ;
72 float getFarPlaneDistance () const ;
76 unsigned int getBlurStrength () const ;
80 bool getLinearDepth () const ;
81
82 // Setters
90 void setSourceTexture (nkGraphics::Texture* value) ;
98 void setSourceDepth (nkGraphics::Texture* value) ;
107 void setCamera (nkGraphics::Camera* value) ;
117 void setNearPlaneDistance (float value) ;
127 void setFocalPlaneDistance (float value) ;
137 void setFocalPlaneThickness (float value) ;
147 void setFarPlaneDistance (float value) ;
157 void setBlurStrength (unsigned int value) ;
168 void setLinearDepth (bool value) ;
169
170 // Load
171 virtual bool load () override ;
172 virtual void unload () override ;
173
174 public :
175
176 // Statics
187 static nkMemory::UniquePtr<DofComplexEffect> create (System* system = nullptr) ;
188 } ;
189 }
nkAstraeus::DofComplexEffect::setFocalPlaneThickness
void setFocalPlaneThickness(float value)
nkAstraeus::DofComplexEffect::setSourceDepth
void setSourceDepth(nkGraphics::Texture *value)
nkAstraeus::DofComplexEffect::getBlurStrength
unsigned int getBlurStrength() const
nkGraphics::Camera
Offers all controls to model a camera.
Definition: Camera.h:14
nkGraphics::Texture
A texture used for rendering, hosted on GPU.
Definition: Texture.h:35
nkAstraeus::DofComplexEffect::getSourceDepth
nkGraphics::Texture * getSourceDepth() const
nkAstraeus::DofComplexEffect::setSourceTexture
void setSourceTexture(nkGraphics::Texture *value)
nkAstraeus::DofComplexEffect::DofComplexEffect
DofComplexEffect(System *system) noexcept
nkAstraeus::DofComplexEffect::getNearPlaneDistance
float getNearPlaneDistance() const
nkAstraeus::System
The main entry point for nkAstraeus engine.
Definition: System.h:15
nkAstraeus::DofComplexEffect::getCamera
nkGraphics::Camera * getCamera() const
nkAstraeus::DofComplexEffect::setFarPlaneDistance
void setFarPlaneDistance(float value)
nkAstraeus::DofComplexEffect::getLinearDepth
bool getLinearDepth() const
nkAstraeus::DofComplexEffect::setLinearDepth
void setLinearDepth(bool value)
nkAstraeus::DofComplexEffect::getOutputTexture
nkGraphics::Texture * getOutputTexture() const
nkAstraeus::ComplexEffect
Base class for all complex effects in the component.
Definition: ComplexEffect.h:18
nkAstraeus::DofComplexEffect::setNearPlaneDistance
void setNearPlaneDistance(float value)
nkAstraeus::DofComplexEffect::setBlurStrength
void setBlurStrength(unsigned int value)
nkAstraeus
Encompasses all API of component NilkinsAstraeus.
Definition: BlurComplexEffect.h:7
nkMemory::UniquePtr
Smart pointer owning the object instance it encapsulates.
Definition: UniquePtr.h:17
nkAstraeus::DofComplexEffect
A Depth of Field effect.
Definition: DofComplexEffect.h:22
nkAstraeus::DofComplexEffect::load
virtual bool load() override
nkAstraeus::DofComplexEffect::unload
virtual void unload() override
nkAstraeus::DofComplexEffect::~DofComplexEffect
virtual ~DofComplexEffect()
nkAstraeus::DofComplexEffect::getFarPlaneDistance
float getFarPlaneDistance() const
nkAstraeus::DofComplexEffect::setCamera
void setCamera(nkGraphics::Camera *value)
nkAstraeus::DofComplexEffect::getFocalPlaneThickness
float getFocalPlaneThickness() const
nkAstraeus::DofComplexEffect::setFocalPlaneDistance
void setFocalPlaneDistance(float value)
nkAstraeus::DofComplexEffect::getSourceTexture
nkGraphics::Texture * getSourceTexture() const
nkAstraeus::DofComplexEffect::create
static nkMemory::UniquePtr< DofComplexEffect > create(System *system=nullptr)
nkAstraeus::DofComplexEffect::getFocalPlaneDistance
float getFocalPlaneDistance() const